home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1991 …esperately Seeking Seven / Desperately Seeking Seven.2mg / Dev.CD.8 / Essentials / Tools / File.Type.Notes / FTN.E0.8006 < prev   
Encoding:
Text File  |  1990-07-27  |  12.4 KB  |  221 lines  |  [04] ASCII Text (0x0000)
  1. Apple II
  2. File Type Notes
  3. _____________________________________________________________________________
  4.                                                   Developer Technical Support
  5.  
  6. File Type:         $E0 (224)
  7. Auxiliary Type:    $8006
  8.  
  9. Full Name:     EZ Backup Saveset document
  10. Short Name:    EZ Backup Saveset document
  11.  
  12. Written by:    Peter Easdown and Matt Deatherage               September 1990
  13.  
  14. Files of this type and auxiliary type contain savesets as produced by 
  15. EZBackup.
  16. _____________________________________________________________________________
  17.  
  18. EZ Backup is a backup utility that runs under GS/OS.  It provides the ability 
  19. to backup to either a removable block device or to files under any available 
  20. file system.
  21.  
  22. For more information on EZ Backup, contact:
  23.  
  24.                     EZ-Soft Pty. Ltd.
  25.                     G.P.O. Box 880
  26.                     Sydney, N.S.W., 2001
  27.                     Australia
  28.                     Telephone:  011.61.2.365.1271
  29.                     AppleLink:  AUST0367
  30.  
  31. The EZ Backup file format is copyrighted (C) 1990 by EZ-Soft Pty. Ltd. and is 
  32. printed here with permission.
  33.  
  34.  
  35. Definitions
  36.  
  37. The following definition is used in this document in addition to those defined 
  38. for all Apple II file types:
  39.  
  40. Date/Time    An eight-byte date/time record as used by GS/OS and the 
  41.              Miscellaneous Tools.
  42.  
  43.  
  44. The File Format
  45.  
  46. EZ Backup savesets are divided into three major segments:  the header, the 
  47. file list and the data.
  48.  
  49. The Header
  50.  
  51. The header contains information relating to the saveset as a whole.  It is a 
  52. fixed length of 1,024 ($400) bytes and is defined as follows:
  53.  
  54.               backupDateTime (+000) Date/Time
  55.                                              The date and time on 
  56.                                              which the backup took place.
  57.               fileCount  (+008)  Word        The number of files stored in 
  58.                                              the saveset.
  59.               rootDirectory (+010) 512 Bytes
  60.                                              A GS/OS input string containing 
  61.                                              the full pathname of the 
  62.                                              top-level directory of the 
  63.                                              saveset.  Note that normally 
  64.                                              this is the volume name of the 
  65.                                              volume that was backed up.
  66.               fileList   (+522)  Long        A pointer used at run-time to 
  67.                                              point to the first entry of 
  68.                                              the file list.  This field 
  69.                                              need not be zeroed when writing 
  70.                                              to disk.
  71.               majRelease (+526)  Word        The major release component of 
  72.                                              the version number of EZ Backup 
  73.                                              used to create the saveset, as 
  74.                                              a two-byte integer.
  75.               minRelease (+528)  Word        The minor release component of 
  76.                                              the version number of EZ Backup 
  77.                                              used to create the saveset, as 
  78.                                              a two-byte integer.
  79.               fileSysID  (+530)  Word        The file system ID of the 
  80.                                              volume that was backed up.
  81.               backupType (+532)  Boolean Word
  82.                                              A flag that indicates whether 
  83.                                              the backup was a full backup or 
  84.                                              an incremental (changes only) 
  85.                                              backup.  A value of TRUE means 
  86.                                              the backup is incremental.
  87.               selected   (+534)  Boolean Word
  88.                                              A run-time flag used to 
  89.                                              indicate that all files in the 
  90.                                              directory tree are selected.  
  91.                                              A value of TRUE indicates that 
  92.                                              all files are selected.
  93.               devIcon    (+536)  Long        A number indicating which icon 
  94.                                              to display for the root level 
  95.                                              when restoring.  This is 
  96.                                              supplied in case the 
  97.                                              configuration of the machine 
  98.                                              doing the restore differs from 
  99.                                              that of the machine that made 
  100.                                              the backup.  Following are the 
  101.                                              icon numbers and device types 
  102.                                              they represent:
  103.  
  104.                                              File Server  $FFF5
  105.                                              CD-ROM       $FFF8
  106.                                              5.25" Drive  $FFF9
  107.                                              RAM Disk     $FFFA
  108.                                              3.5" Disk    $FFFB
  109.                                              5.25" Disk   $FFFC
  110.                                              Hard Disk    $FFFD
  111.  
  112.               fileListLen (+540) Long        The length in bytes of the 
  113.                                              file list (defined later).
  114.               totalDisks (+544)  Long        The number of disks required 
  115.                                              by the saveset (excluding the 
  116.                                              disk containing the file list).  
  117.                                              Note that this is not relevant 
  118.                                              to a file-based backup since a 
  119.                                              saveset file cannot be larger 
  120.                                              than the disk on which it 
  121.                                              resides.
  122.               reserved   (+548)  Word        Reserved for future use.
  123.               backupLen  (+550)  Long        The total size in bytes of the 
  124.                                              backup, including the header, 
  125.                                              the file list and the data.
  126.               reserved   (+554)  470 Bytes   Reserved for future use.
  127.  
  128. The File List
  129.  
  130. The file list contains a variable number of 128-byte records, the number of 
  131. which is given by the fileCount field in the header.  Each file list entry is 
  132. defined as follows:
  133.  
  134.               nextFile   (+000)  Long        A pointer that is used at run-
  135.                                              time to point to the next file 
  136.                                              in the file list.  Although 
  137.                                              only used a run-time, this 
  138.                                              field is useful in 
  139.                                              reconstructing the directory 
  140.                                              hierarchy when restoring 
  141.                                              savesets.
  142.               fileInfo   (+004)  62 Bytes    A GS/OS GetDirEntry parameter 
  143.                                              block that describes this file.
  144.               dataOffset (+066)  Long        An offset in bytes from the 
  145.                                              beginning of the file that 
  146.                                              points to the location within 
  147.                                              the saveset at which the data 
  148.                                              fork (if any) is stored.  This 
  149.                                              field is zero if there is no 
  150.                                              data fork.
  151.               resOffset  (+070)  Long        An offset in bytes from the 
  152.                                              beginning of the file that 
  153.                                              points to the location within 
  154.                                              the saveset at which the 
  155.                                              resource fork (if any) is 
  156.                                              stored.  This field is zero if 
  157.                                              there is no resource fork.
  158.               optionListOffset (+074) Long   An offset in bytes from the 
  159.                                              beginning of the file that 
  160.                                              points to the location within 
  161.                                              the saveset at which the GS/OS 
  162.                                              option_list (if any) was 
  163.                                              stored.  This field is zero if 
  164.                                              there is no option_list.  
  165.                                              Note that EZ Backup does not 
  166.                                              currently store the option_list 
  167.                                              for any ProDOS files.
  168.               optionListLen (+078) Word      The length in bytes of the 
  169.                                              option_list (if any).
  170.               parentFile (+080)  Long        A pointer that contains the 
  171.                                              run-time address of the file 
  172.                                              list record of the directory 
  173.                                              that is a parent to the file 
  174.                                              described by this record.  
  175.                                              Although only used a run-time, 
  176.                                              this field is useful in 
  177.                                              reconstructing the directory 
  178.                                              hierarchy when restoring 
  179.                                              savesets.
  180.               currentDir (+084)  Long        If the file described by this 
  181.                                              record is a directory, this 
  182.                                              field is a pointer to itself.  
  183.                                              This is supplied primarily for 
  184.                                              the restore operation so that 
  185.                                              the directory hierarchy may 
  186.                                              be rebuilt.
  187.               selected   (+088)  Word        Used at run-time to indicate a 
  188.                                              file record selection mode.  
  189.                                              If this field is zero, then 
  190.                                              some error occurred during the 
  191.                                              backup that prevented the file 
  192.                                              from being backed up.  A 
  193.                                              non-zero value indicates that 
  194.                                              the file was correctly included 
  195.                                              in the saveset; only attempt to 
  196.                                              restore files that have a 
  197.                                              non-zero selection mode.
  198.               created    (+090)  Boolean Word
  199.                                              A flag used at restore time to 
  200.                                              indicate whether the file was 
  201.                                              created successfully.  A value 
  202.                                              of TRUE means yes while FALSE 
  203.                                              means no.
  204.               fileName   (+092)  36 Bytes    A GS/OS output string 
  205.                                              containing the name of the file.
  206.  
  207. The Data
  208.  
  209. The data component of the file contains the contents of all of the files 
  210. described in the file list in a contiguous stream of bytes.  Each file begins 
  211. at a 512-byte boundary.  Each file list record takes 128 bytes, and any 
  212. remaining bytes in the last 512-byte block of the file list are unused.  
  213. Similarly, all stored data forks, resource forks, and option_lists start on 
  214. 512-byte boundaries, and any remaining bytes in their last 512-byte blocks are 
  215. unused.
  216.  
  217.  
  218. Further Reference
  219. _____________________________________________________________________________
  220.   o  GS/OS Reference
  221.